/*
 * Copyright (C) 2017 skydoves
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.skydoves.preferenceroom;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Marks a class as an SharedPreference data. This class will have a mapping SharedPreference with
 * Upper camel case.
 */
@Documented
@Target(TYPE)
@Retention(RUNTIME)
public @interface PreferenceEntity {
    /**
     * Preference entity name of the SharedPreference persistence. w
     *
     * <p>If not used, the class generated entity class name will be upper camel case of the class
     * name.
     *
     * @return The Preference name of the SharedPreference entity.
     */
    String value() default "";
}
